<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SET DESCRIPTOR</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.1.2 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Embedded SQL Commands"
HREF="ecpg-sql-commands.html"><LINK
REL="PREVIOUS"
TITLE="SET CONNECTION"
HREF="ecpg-sql-set-connection.html"><LINK
REL="NEXT"
TITLE="TYPE"
HREF="ecpg-sql-type.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2011-12-01T22:07:59"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.1.2 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SET CONNECTION"
HREF="ecpg-sql-set-connection.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="ecpg-sql-commands.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="TYPE"
HREF="ecpg-sql-type.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="ECPG-SQL-SET-DESCRIPTOR"
></A
>SET DESCRIPTOR</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN43505"
></A
><H2
>Name</H2
>SET DESCRIPTOR&nbsp;--&nbsp;set information in an SQL descriptor area</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN43508"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>SET DESCRIPTOR <TT
CLASS="REPLACEABLE"
><I
>descriptor_name</I
></TT
> <TT
CLASS="REPLACEABLE"
><I
>descriptor_header_item</I
></TT
> = <TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
> [, ... ]
SET DESCRIPTOR <TT
CLASS="REPLACEABLE"
><I
>descriptor_name</I
></TT
> VALUE <TT
CLASS="REPLACEABLE"
><I
>number</I
></TT
> <TT
CLASS="REPLACEABLE"
><I
>descriptor_item</I
></TT
> = <TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
> [, ...]</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN43517"
></A
><H2
>Description</H2
><P
>     <TT
CLASS="COMMAND"
>SET DESCRIPTOR</TT
> populates an SQL descriptor
     area with values.  The descriptor area is then typically used to
     bind parameters in a prepared query execution.
    </P
><P
>     This command has two forms: The first form applies to the
     descriptor <SPAN
CLASS="QUOTE"
>"header"</SPAN
>, which is independent of a
     particular datum.  The second form assigns values to particular
     datums, identified by number.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN43523"
></A
><H2
>Parameters</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="REPLACEABLE"
><I
>descriptor_name</I
></TT
></DT
><DD
><P
>        A descriptor name.
       </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>descriptor_header_item</I
></TT
></DT
><DD
><P
>        A token identifying which header information item to set.
        Only <TT
CLASS="LITERAL"
>COUNT</TT
>, to set the number of descriptor
        items, is currently supported.
       </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>number</I
></TT
></DT
><DD
><P
>        The number of the descriptor item to set.  The count starts at
        1.
       </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>descriptor_item</I
></TT
></DT
><DD
><P
>        A token identifying which item of information to set in the
        descriptor.  See <A
HREF="ecpg-descriptors.html#ECPG-NAMED-DESCRIPTORS"
>Section 33.7.1</A
> for a
        list of supported items.
       </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
></DT
><DD
><P
>        A value to store into the descriptor item.  This can be an SQL
        constant or a host variable.
       </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN43553"
></A
><H2
>Examples</H2
><PRE
CLASS="PROGRAMLISTING"
>EXEC SQL SET DESCRIPTOR indesc COUNT = 1;
EXEC SQL SET DESCRIPTOR indesc VALUE 1 DATA = 2;
EXEC SQL SET DESCRIPTOR indesc VALUE 1 DATA = :val1;
EXEC SQL SET DESCRIPTOR indesc VALUE 2 INDICATOR = :val1, DATA = 'some string';
EXEC SQL SET DESCRIPTOR indesc VALUE 2 INDICATOR = :val2null, DATA = :val2;</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN43556"
></A
><H2
>Compatibility</H2
><P
>     <TT
CLASS="COMMAND"
>SET DESCRIPTOR</TT
> is specified in the SQL standard.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN43560"
></A
><H2
>See Also</H2
><A
HREF="ecpg-sql-allocate-descriptor.html"
>ALLOCATE DESCRIPTOR</A
>, <A
HREF="ecpg-sql-get-descriptor.html"
>GET DESCRIPTOR</A
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="ecpg-sql-set-connection.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="ecpg-sql-type.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SET CONNECTION</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ecpg-sql-commands.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>TYPE</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>